home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / bbs / str_utilities3.lha / str.utils / docs / STR.LogOn.doc < prev    next >
Text File  |  1994-07-07  |  6KB  |  195 lines
  1.  
  2.                         The ST/R Utilities Package
  3.                                  Release 3
  4.  
  5.                                     By:
  6.  
  7.                             Douglas McLaughlin
  8.                                [Black Fire]
  9.  
  10. * All new or updated information since the last release will have a star in
  11.   the left column.
  12.  
  13. ------------------------------------------------------------------------------
  14.  
  15.                               STR.LogOn.rexx
  16.                               STR.LogOn.Mcfg
  17.  
  18.  
  19. INSTALLATION:
  20.  
  21.   File Locations:
  22.  
  23.     STR.LogOn.rexx ---> Doors:STR.Utils/
  24.     STR.LogOn.Mcfg ---> Doors:STR.Utils/
  25.  
  26.   Install in BBS:
  27.  
  28.     To install STR.LogOn.rexx, create or add the following line to your
  29.     "TEXT.WELCOME.USER" file in the BBS:TEXT/ENGLISH/ directory:
  30.         
  31. \#0Doors:STR.Utils/STR.LogOn.rexx\
  32.  
  33.     To install STR.LogOn.rexx as a door utility, ensure that all users
  34.     have access to the program and the description for the program *MUST*
  35.     have "Logon Manager" somewhere in it.  This is case-sensitive and you
  36.     must use upper and lower case as shown.
  37.  
  38.     STR.LogOn.Mcfg is the main configuration file for the Logon Manager.
  39.  
  40.  
  41. REQUIREMENTS:
  42.  
  43.  
  44.   Any Amiga ;)
  45.  
  46.     The faster the better! =)
  47.  
  48.   OS 2.04+
  49.  
  50.     Untested with, but should work fine with, OS 3.0/3.1
  51.  
  52.   ARexx:
  53.   
  54.     RexxMast should be run in your s:user-startup.
  55.     rexxsupport.library should be installed in Libs:
  56.   
  57.   Excelsior! BBS v1.20+
  58.  
  59.     Works fine with v1.21 as well.
  60.  
  61.  
  62. KNOWN BUGS:
  63.  
  64.  
  65.   None at this time.
  66.  
  67.   You can't pass arguments to an ARexx program called from the EX.BBSMenus
  68.   file or an IPL command.  Another "Feature" that needs changing.
  69.  
  70.  
  71. CONFIGURATION:
  72.  
  73.  
  74.   STR.LogOn.rexx
  75.  
  76.     datapath  - This should be the path to the STR.LogOn.Mcfg configuration
  77.                 file.
  78.  
  79.     runagain  - If you set this to 1, the user will be allowed to run through
  80.                 the log-on sequence when the program is executed as a door.
  81.                 When set to 0, this option is not available.
  82.  
  83.     mandatory - If you set this to 1, the user has no choice but to create
  84.                 a log-on sequence.  When set to 0, the user is asked if s/he
  85.                 would like to create a sequence.
  86.  
  87.   STR.LogOn.Mcfg
  88.  
  89.     This is the main configuration for the Logon Manager.  Each entry in
  90.     the file contains three lines:
  91.  
  92.     Line 1:
  93.  
  94.       This is a description of the item.  It shouldn't be any longer than
  95.       about 40 characters.
  96.  
  97.     Line 2:
  98.  
  99.       This is the IPL command used to launch the program or view the text
  100.       file, whichever the case may be.  Please refer to your Excelsior!
  101.       User's Manual for a description of these IPL commands.  (If you have
  102.       one!)
  103.  
  104.     Line 3:
  105.  
  106.       This is the flags line.  Currently there are four flags defined:
  107.  
  108.       1 - Clear the screen before launching the program or viewing the
  109.           text file.
  110.  
  111.       2 - After the program or text file is finished, Print a "Press Return"
  112.           message and wait for a keypress before continuing with the Logon
  113.           Manager.
  114.  
  115.       4 - When this flag is set, the item is mandatory and will automatically
  116.           be added to the user's log-on sequence.
  117.  
  118. *     8 - When this flag is set, the flags line also contains an argument
  119.           for the called program, separated from the flag by a (;) semi-colon.
  120.           For example:
  121.  
  122.             8;1    <- Passes "1" as the argument.
  123.             9;name <- Passes "name" as the argument, with screen clear.
  124.  
  125.           See the included STR.LogOn.Mcfg for more examples.
  126.  
  127.       To have the Logon manager execute more than one flag, add them together.
  128.       ie. for both a clear screen and the "Press Return" prompt, use a 3.
  129.           for both a clear screen and a mandatory item, use 5.
  130.  
  131.  
  132. PURPOSE & FEATURES:
  133.  
  134.  
  135.   STR.LogOn.rexx
  136.  
  137.     When I first read the docs for the RoT_Logon program, I thought, "Wow!
  138.     this is a cool program and a great idea!"  Well, after I installed the
  139.     program I found that it just didn't work the way I thought it should,
  140.     and my users were very annoyed by its lack of intelligence.
  141.  
  142.     Thus, STR.LogOn.rexx....  This is a very short ARexx program.  It reads
  143.     in its data file, STR.LogOn.Mcfg, and prompts users if they would like
  144.     to execute or see the items listed.  Once the user has made his/her
  145.     choices, it stores a file called STR.LogOn.Ucfg in the user's private
  146.     directory.  After that, the user is never again prompted if they would
  147.     like to see this or that at logon time.
  148.  
  149.     The only exception is when you change the STR.LogOn.Mcfg file.  The
  150.     Logon Manager compares the file dates of the STR.LogOn.Ucfg against the
  151.     STR.LogOn.Mcfg.  If the date on the Mcfg is newer than the Ucfg, the
  152.     options must have changed and the user is asked if s/he would like to
  153.     re-edit the logon sequence.
  154.  
  155.     When the STR.LogOn.rexx program is run as a door utility, it allows the
  156.     user to re-edit the logon sequence even when no items have changed.
  157.  
  158.  
  159. HISTORY:
  160.  
  161.  
  162. * Version 1.11:
  163.  
  164.     Added the ability to pass any program an argument string.  The string
  165.     will be in the file "T:RexxArg{NODE}", where {NODE} is the current node
  166.     number of the parent BB.  ie. "T:RexxArg1"  Other E! developers are more
  167.     than welcome to use this feature in their programs, of course, they will
  168.     only run from the Logon Manager! ;)
  169.  
  170. * Version 1.1 Release 3:
  171.  
  172.     Changed the screen clear from using the IPL \f1 to simply sending the
  173.     ASCII code 12, Top of Form.  This is such a small change, I didn't
  174.     bother to bump the revision.
  175.  
  176.   Version 1.1:
  177.  
  178.     Completely re-wrote the logic flow of the program.  The changes are
  179.     transparent to the user, but the program's flow makes a lot more sense
  180.     and can be added to much more easily.
  181.  
  182.     Added the ability to make inidividual items or even the whole list
  183.     mandatory.
  184.  
  185.     Added the ability for a user to run through the log-on sequence when the
  186.     program is executed as a door program.
  187.  
  188.   Version 1.01:
  189.  
  190.     Ooops!  STR.LogOn.rexx is now "Dropped Carrier" aware!
  191.  
  192.   Version 1.0:
  193.  
  194.     First public release.
  195.